API docs by Redocly

Network Insight APIs (1.0.0.1768563038)

Download OpenAPI specification:

CCUK: support@cowdrey.net URL: https://www.cowdrey.net/ License: Proprietary License

Network Insight provides analytical and prediction insights for telecommunications infrastructure and services.

Application User Manual

APIs

Return either JSON or YAML OpenAPI definition

Authorizations:
openId

Responses

Response samples

Content type
"string"

Returns a simple status response about the operational state of NI (readiness)

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "point": "20241118T150800"
}

UI Helpers

Returns a simple resource statistics held in NI

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "providers": {
    },
  • "alerts": {
    },
  • "queues": {
    },
  • "resources": {
    }
}

Get default Map render URL details for UI usage

Authorizations:
openId

Responses

Response samples

Content type
application/json
{}

Alerts

Export alerts in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of all available alerts

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
  • "3e8c816b-499d-4809-bc97-3f17d3fff2a5",
  • "6d3bd8bd-093f-4f17-b391-5f4f83984a97",
  • "6aa7845b-e6fa-4668-a0cc-45d5b46fa4cc",
  • "aee8b41f-97ab-4e35-88c7-b40391dca6f7",
  • "438463bc-9f9f-4410-b937-2d3acd04b24e",
  • "16bbab26-545e-4ece-b55c-015a34f19847",
  • "ebbb4134-f0fd-4c9f-99bf-c994ddc15890",
  • "370a5524-781c-4f5f-b47d-c498c3f60839"
]

Add single alert

Authorizations:
openId
Request Body schema: application/json
required
description
required
string
delete
required
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

function
required
string
Default: "noop();"

Responses

Request samples

Content type
application/json
{
  • "description": "Switching/Routing Classifiers",
  • "delete": false,
  • "function": "noop();"
}

Response samples

Content type
application/json
{
  • "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7"
}

Remove single alert

Authorizations:
openId
path Parameters
alertId
required
string <uuid>

internal alert identifier

Responses

Response samples

Content type
application/json
{ }

Update aspects of a single alert

Authorizations:
openId
path Parameters
alertId
required
string <uuid>

internal alert identifier

Request Body schema: application/json
required
description
string
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

function
string
Default: "noop();"

Responses

Request samples

Content type
application/json
{
  • "function": "jobAlertNePortUtil75();"
}

Response samples

Content type
application/json
{ }

Get specified alert details

Authorizations:
openId
path Parameters
alertId
required
string <uuid>

internal alert identifier

Responses

Response samples

Content type
application/json
{
  • "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
  • "description": "Switching/Routing Classifiers",
  • "delete": false
}

List single alert content details

Authorizations:
openId
path Parameters
alertContentId
required
string <uuid>

internal alert content identifier

Responses

Response samples

Content type
application/json
{
  • "alertContentId": "35c94368-5c16-4689-b506-8b1b952077ec",
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "point": "stringstringstr",
  • "content": "string"
}

Remove single alert content

Authorizations:
openId
path Parameters
alertContentId
required
string <uuid>

internal alert content identifier

Responses

Response samples

Content type
application/json
{ }

List all alert content

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "312bd231-f52b-41eb-af17-d3caa730c209",
  • "e60f9712-dda3-4537-9538-17e96e87bd0d"
]

Add single alert content

Authorizations:
openId
Request Body schema: application/json
required
alertId
required
string <uuid> (alertId)

internal alert identifier

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
content
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "point": "stringstringstr",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "alertContentId": "e60f9712-dda3-4537-9538-17e96e87bd0d"
}

List known and impacting CVEs for specified NE

Authorizations:
openId
path Parameters
neId
required
string <uuid>

internal network equipment identifier

Responses

Response samples

Content type
application/json
{
  • "known": [
    ],
  • "impacting": [
    ]
}

List single CVE details

Authorizations:
openId
path Parameters
cveId
required
stringCVE-[0-9]{4}-[0-9]{4}

external CVE identifier

Responses

Response samples

Content type
application/json
{
  • "cveId": "CVE-2025-5516",
  • "published": "20250516T181900",
  • "vendor": "Cowdrey Consulting",
  • "uri": "2025/5xxx/CVE-2025-5516.json",
  • "platforms": [
    ],
  • "versions": [
    ]
}

Remove single CVE

Authorizations:
openId
path Parameters
cveId
required
stringCVE-[0-9]{4}-[0-9]{4}

external CVE identifier

Responses

Response samples

Content type
application/json
{ }

List all CVE for known vendors

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "CVE-2025-5880",
  • "CVE-2025-5881"
]

Add single CVE

Authorizations:
openId
Request Body schema: application/json
required
cveId
required
string (cveId) CVE-[0-9]{4}-[0-9]{4,}

external CVE identifier

published
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
unpdated
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
vendor
required
string
uri
required
string <url>
platforms
required
Array of strings non-empty
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "cveId": "CVE-2025-5516",
  • "published": "20250516T181900",
  • "vendor": "Cowdrey Consulting",
  • "uri": "2025/5xxx/CVE-2025-5516.json",
  • "platforms": [
    ],
  • "versions": [
    ]
}

Response samples

Content type
application/json
{
  • "cveId": "CVE-2025-5516"
}

Subscribe to one or more alerts

Authorizations:
openId
Request Body schema: application/json
required
requestorId
required
string <uuid> (requestorId)

unique identifier of the requesting originator

required
Array of objects non-empty

Responses

Callbacks

Request samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Response samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Callback payload samples

Callback
POST: expected alert callback
Content type
application/json
{
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "content": { }
}

Unsubscribe from one or more alerts

Authorizations:
openId
query Parameters
requestorId
required
string <uuid>

unique identifier of the requesting originator

subscriptionId
required
Array of strings <uuid> [ items <uuid > ]

one or more unique subscription identifiers to unsubscribe from, serialized as subscriptionId=(29a4feb9-1429-4a63-84e8-dd01989f1ec5,33ab44b4-fe7a-4160-9b5d-6145284b5b57)

Responses

Response samples

Content type
application/json
{ }

Publish one or more alerts to Kafka broker

Authorizations:
openId
Request Body schema: application/json
required
requestorId
required
string <uuid> (requestorId)

unique identifier of the requesting originator

required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Response samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Unpublish one or more alerts

Authorizations:
openId
query Parameters
requestorId
required
string <uuid>

unique identifier of the requesting originator

publicationId
required
Array of strings <uuid> [ items <uuid > ]

one or more unique publishing identifiers to unpublish from, serialized as publicationId=(29a4feb9-1429-4a63-84e8-dd01989f1ec5,33ab44b4-fe7a-4160-9b5d-6145284b5b57)

Responses

Response samples

Content type
application/json
{ }

get one alert definition

Authorizations:
openId
path Parameters
notificationId
required
string <uuid>

single alert notifying identifier

Responses

Response samples

Content type
application/json
{
  • "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
  • "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
  • "subject": "ni-L23-classifiers alert",
  • "recipients": [
    ]
}

notify one or more alerts to Email recipient

Authorizations:
openId
Request Body schema: application/json
required
requestorId
required
string <uuid> (requestorId)

unique identifier of the requesting originator

required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Response samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Unnotify one or more alerts

Authorizations:
openId
query Parameters
requestorId
required
string <uuid>

unique identifier of the requesting originator

notificationId
required
Array of strings <uuid> [ items <uuid > ]

one or more unique notifying identifiers to cease, serialized as notificationId=(29a4feb9-1429-4a63-84e8-dd01989f1ec5,33ab44b4-fe7a-4160-9b5d-6145284b5b57)

Responses

Response samples

Content type
application/json
{ }

Assign one or more alerts to a workflow runner

Authorizations:
openId
Request Body schema: application/json
required
requestorId
required
string <uuid>

unique identifier of the requesting originator

required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Response samples

Content type
application/json
{
  • "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
  • "alerts": [
    ]
}

Unassign one or more alerts from a workflow runner

Authorizations:
openId
query Parameters
requestorId
required
string <uuid>

unique identifier of the requesting originator

workflowRunnerId
required
Array of strings <uuid> [ items <uuid > ]

one or more unique workflow runner identifiers to cease, serialized as workflowRunnerId=(29a4feb9-1429-4a63-84e8-dd01989f1ec5,33ab44b4-fe7a-4160-9b5d-6145284b5b57)

Responses

Response samples

Content type
application/json
{ }

Remove item from internal alert queue

Authorizations:
openId
path Parameters
qId
required
integer >= 0

internal prediction queue identifier

Responses

Response samples

Content type
application/json
{ }

Returns next item awaiting processing from internal alert queue

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "qId": 1,
  • "point": "20250603T181900",
  • "type": "callback",
  • "id": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
  • "callback": "3ffc8917-f24d-4d6d-9665-83ecaf05feee"
}

Costs - Cable

List known cable costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Add single cable cost

Authorizations:
openId
Request Body schema: application/json
required
technology
required
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

unit
required
string (sizeUnit)
Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet"

unit of measure of the dimension:

  • cm metric centimetres
  • mm metric millimetres
  • m metric metres
  • km meric kilometres
  • Mm metric megametres
  • inch imperial inches
  • feet imperial feet
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "technology": "coax",
  • "unit": "m",
  • "costPerUnit": 1
}

Response samples

Content type
application/json
{ }

Replace single existing cable cost

Authorizations:
openId
Request Body schema: application/json
required
technology
required
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

unit
required
string (sizeUnit)
Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet"

unit of measure of the dimension:

  • cm metric centimetres
  • mm metric millimetres
  • m metric metres
  • km meric kilometres
  • Mm metric megametres
  • inch imperial inches
  • feet imperial feet
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "technology": "singleFiber",
  • "unit": "m",
  • "costPerUnit": 1.5
}

Response samples

Content type
application/json
{ }

Remove single cable cost

Authorizations:
openId
Request Body schema: application/json
required
technology
required
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

Responses

Request samples

Content type
application/json
{
  • "technology": "coax"
}

Response samples

Content type
application/json
{ }

Costs - Duct

List known duct costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add single duct cost

Authorizations:
openId
Request Body schema: application/json
required
category
required
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
required
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

unit
required
string (sizeUnit)
Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet"

unit of measure of the dimension:

  • cm metric centimetres
  • mm metric millimetres
  • m metric metres
  • km meric kilometres
  • Mm metric megametres
  • inch imperial inches
  • feet imperial feet
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "category": "duct",
  • "configuration": 24,
  • "unit": "m",
  • "costPerUnit": 2
}

Response samples

Content type
application/json
{ }

Replace single existing duct cost

Authorizations:
openId
Request Body schema: application/json
required
category
required
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
required
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

unit
required
string (sizeUnit)
Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet"

unit of measure of the dimension:

  • cm metric centimetres
  • mm metric millimetres
  • m metric metres
  • km meric kilometres
  • Mm metric megametres
  • inch imperial inches
  • feet imperial feet
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "category": "duct",
  • "configuration": 12,
  • "unit": "m",
  • "costPerUnit": 1.1
}

Response samples

Content type
application/json
{ }

Remove single duct cost

Authorizations:
openId
Request Body schema: application/json
required
category
required
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
required
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

Responses

Request samples

Content type
application/json
{
  • "category": "duct",
  • "configuration": 19
}

Response samples

Content type
application/json
{ }

Costs - Ne

List known ne costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Add single ne cost

Authorizations:
openId
Request Body schema: application/json
required
vendor
required
string
model
required
string
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "vendor": "Juniper Networks",
  • "model": "MX250",
  • "costPerUnit": 32768
}

Response samples

Content type
application/json
{ }

Replace single existing ne cost

Authorizations:
openId
Request Body schema: application/json
required
vendor
required
string
model
required
string
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "vendor": "Juniper Networks",
  • "model": "MX240",
  • "costPerUnit": 26250
}

Response samples

Content type
application/json
{ }

Remove single ne cost

Authorizations:
openId
Request Body schema: application/json
required
vendor
required
string
model
required
string

Responses

Request samples

Content type
application/json
{
  • "vendor": "Juniper Networks",
  • "model": "MX250"
}

Response samples

Content type
application/json
{ }

Costs - Pole

List known pole costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add single pole cost

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

classifier
required
string (heightClassifier)
Enum: "residential" "rural" "commercial" "urban" "highways" "unclassified"

summary of height of the (telegraph) pole

costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "purpose": "link",
  • "classifier": "commercial",
  • "costPerUnit": 1
}

Response samples

Content type
application/json
{ }

Replace single existing pole cost

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

classifier
required
string (heightClassifier)
Enum: "residential" "rural" "commercial" "urban" "highways" "unclassified"

summary of height of the (telegraph) pole

costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "purpose": "link",
  • "classifier": "commercial",
  • "costPerUnit": 2.5
}

Response samples

Content type
application/json
{ }

Remove single pole cost

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

classifier
required
string (heightClassifier)
Enum: "residential" "rural" "commercial" "urban" "highways" "unclassified"

summary of height of the (telegraph) pole

Responses

Request samples

Content type
application/json
{
  • "purpose": "link",
  • "classifier": "commercial"
}

Response samples

Content type
application/json
{ }

Costs - Rack

List known rack costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add single rack cost

Authorizations:
openId
Request Body schema: application/json
required
slots
required
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "slots": 24,
  • "costPerUnit": 24
}

Response samples

Content type
application/json
{ }

Replace single existing rack cost

Authorizations:
openId
Request Body schema: application/json
required
slots
required
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "slots": 48,
  • "costPerUnit": 50
}

Response samples

Content type
application/json
{ }

Remove single rack cost

Authorizations:
openId
Request Body schema: application/json
required
slots
required
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

Responses

Request samples

Content type
application/json
{
  • "slots": 48
}

Response samples

Content type
application/json
{ }

Costs - Service

List known service costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Add single service cost

Authorizations:
openId
Request Body schema: application/json
required
type
required
string (serviceType)
Enum: "broadband" "circuit" "ethernet" "fttx" "optical" "sogea" "unclassified" "voice"

intended offering of the suppplied service, note:

  • broadband includes residential offerings such as xDSL and DOCSIS
  • sogea is Single Order Generic Ethernet Access which is replacing traditional broadband offerings
  • fttx includes FTTC, FTTH, FTTP andd other variants
  • ethernet is wholesale or enterprise point-to-point ethernet connectivity
  • optical is layer 1 connectivity
  • voice is the traditional required extra voice telephony service offered with broadband
rate
required
integer [ 1 .. 768 ]
unit
required
string
Enum: "Mbps" "Gbps" "Tbps"
lagMembers
integer [ 0 .. 256 ]
Default: 0
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "type": "circuit",
  • "rate": 256,
  • "unit": "Mbps",
  • "costPerUnit": 34.56
}

Response samples

Content type
application/json
{ }

Replace single existing service cost

Authorizations:
openId
Request Body schema: application/json
required
type
required
string (serviceType)
Enum: "broadband" "circuit" "ethernet" "fttx" "optical" "sogea" "unclassified" "voice"

intended offering of the suppplied service, note:

  • broadband includes residential offerings such as xDSL and DOCSIS
  • sogea is Single Order Generic Ethernet Access which is replacing traditional broadband offerings
  • fttx includes FTTC, FTTH, FTTP andd other variants
  • ethernet is wholesale or enterprise point-to-point ethernet connectivity
  • optical is layer 1 connectivity
  • voice is the traditional required extra voice telephony service offered with broadband
rate
required
integer [ 1 .. 768 ]
unit
required
string
Enum: "Mbps" "Gbps" "Tbps"
lagMembers
integer [ 0 .. 256 ]
Default: 0
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "type": "circuit",
  • "rate": 256,
  • "unit": "Mbps",
  • "costPerUnit": 56.78
}

Response samples

Content type
application/json
{ }

Remove single service cost

Authorizations:
openId
Request Body schema: application/json
required
type
required
string (serviceType)
Enum: "broadband" "circuit" "ethernet" "fttx" "optical" "sogea" "unclassified" "voice"

intended offering of the suppplied service, note:

  • broadband includes residential offerings such as xDSL and DOCSIS
  • sogea is Single Order Generic Ethernet Access which is replacing traditional broadband offerings
  • fttx includes FTTC, FTTH, FTTP andd other variants
  • ethernet is wholesale or enterprise point-to-point ethernet connectivity
  • optical is layer 1 connectivity
  • voice is the traditional required extra voice telephony service offered with broadband
rate
required
integer [ 1 .. 768 ]
unit
required
string
Enum: "Mbps" "Gbps" "Tbps"
lagMembers
integer [ 0 .. 256 ]
Default: 0

Responses

Request samples

Content type
application/json
{
  • "type": "circuit",
  • "rate": 256,
  • "unit": "Mbps"
}

Response samples

Content type
application/json
{ }

Costs - Site

List known site costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Add single site cost

Authorizations:
openId
Request Body schema: application/json
required
area
required
string (areaType)
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
required
string (siteType)
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "area": "mixed",
  • "type": "street",
  • "costPerUnit": 1
}

Response samples

Content type
application/json
{ }

Replace single existing site cost

Authorizations:
openId
Request Body schema: application/json
required
area
required
string (areaType)
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
required
string (siteType)
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "area": "mixed",
  • "type": "street",
  • "costPerUnit": 2.5
}

Response samples

Content type
application/json
{ }

Remove single site cost

Authorizations:
openId
Request Body schema: application/json
required
area
required
string (areaType)
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
required
string (siteType)
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known

Responses

Request samples

Content type
application/json
{
  • "area": "psz",
  • "type": "exchange"
}

Response samples

Content type
application/json
{ }

Costs - Trench

List known trench costs

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add single trench cost

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

type
string (constructionType)
Enum: "micro" "narrow" "backhoe" "inline" "portable" "large"

only include when purpose is unclassified

unit
required
string (sizeUnit)
Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet"

unit of measure of the dimension:

  • cm metric centimetres
  • mm metric millimetres
  • m metric metres
  • km meric kilometres
  • Mm metric megametres
  • inch imperial inches
  • feet imperial feet
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "purpose": "service/drop",
  • "unit": "m",
  • "costPerUnit": 5
}

Response samples

Content type
application/json
{ }

Replace single existing trench cost

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

type
string (constructionType)
Enum: "micro" "narrow" "backhoe" "inline" "portable" "large"

only include when purpose is unclassified

unit
required
string (sizeUnit)
Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet"

unit of measure of the dimension:

  • cm metric centimetres
  • mm metric millimetres
  • m metric metres
  • km meric kilometres
  • Mm metric megametres
  • inch imperial inches
  • feet imperial feet
costPerUnit
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "purpose": "service/drop",
  • "unit": "m",
  • "costPerUnit": 5.5
}

Response samples

Content type
application/json
{ }

Remove single trench cost

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

type
string (constructionType)
Enum: "micro" "narrow" "backhoe" "inline" "portable" "large"

only include when purpose is unclassified

Responses

Request samples

Content type
application/json
{
  • "purpose": "service/drop"
}

Response samples

Content type
application/json
{ }

Cables

Export cables in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import cables in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
One of
cableId
string <uuid> (cableId)

optionally specify the internal cable identifier

country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
poleId
required
string <uuid> (poleId)

internal pole identifier

point
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
technology
required
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

required
object or object or object or object or object (cableConfiguration)
state
required
string (cableState)
Enum: "free" "used" "reserved" "faulty"

usage state of cable

source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "5520aca1-4727-431a-aa9c-23f2e54b8a41"
]

List of all known cables

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "5520aca1-4727-431a-aa9c-23f2e54b8a41",
  • "3970af86-e19f-4e4c-810b-246aea08f941",
  • "84eabb13-c76e-466d-8993-7d7ee4695682",
  • "31d0f438-0f60-4b09-917e-95f373af9fd2",
  • "c731866d-7347-4e56-acf9-abab931cf83e",
  • "6bbbd7f1-f551-489b-abfc-fcf0be0880ce",
  • "d321fc40-8cb9-4db5-99d7-5c5e96d2a146",
  • "d5527663-e75f-41c5-a7a4-7db82ed49b07",
  • "77ece265-d111-40c6-b4e2-1aa5e8c182aa",
  • "b8e322d3-6004-43ad-93c1-7ba73ec4fe97"
]

Add single cable

Authorizations:
openId
Request Body schema: application/json
One of
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
poleId
required
string <uuid> (poleId)

internal pole identifier

technology
required
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

required
object or object or object or object or object (cableConfiguration)
state
string (cableState)
Enum: "free" "used" "reserved" "faulty"

usage state of cable

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
Example
{
  • "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
  • "country": "BEL",
  • "cost": 2.5,
  • "technology": "ethernet",
  • "configuration": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41"
}

Simple statistics for cables

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

State capacity for cables

Authorizations:
openId
query Parameters
from
string = 8 characters ^\d{8}$

range start date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
to
string = 8 characters ^\d{8}$

range end date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
before
string = 8 characters ^\d{8}$

before date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
after
string = 8 characters ^\d{8}$

after date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
aggregate
required
string
Enum: "day" "week" "month" "quarter" "half-year" "year"

unit of measure of the aggregation factor

Responses

Response samples

Content type
application/json
{
  • "by": "hour",
  • "cable": [
    ]
}

delete single cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Replace entire single cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

Request Body schema: application/json
required
One of
ductId
required
string <uuid> (ductId)

internal duct identifier

country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
technology
required
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

required
object or object or object or object or object (cableConfiguration)
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
Example
{
  • "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
  • "country": "BEL",
  • "technology": "multiFiber",
  • "configuration": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Update aspects of a single cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

Request Body schema: application/json
required
One of
cableId
string <uuid> (cableId)

internal cable identifier

country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
ductId
string <uuid> (ductId)

internal duct identifier

technology
string (cableTechnology)
Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber"

technology domain of cable

object or object or object or object or object (cableConfiguration)
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
Example
{
  • "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
  • "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
  • "country": "BEL",
  • "technology": "multiFiber",
  • "configuration": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Get specified cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
Example
{
  • "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
  • "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
  • "configuration": {
    },
  • "technology": "ethernet",
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Update usage state specific fiber strand inside a fiber optic cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

strand
required
integer [ 1 .. 48 ]

fiber optic cable strand number

Request Body schema: application/json
required
state
string (cableState)
Enum: "free" "used" "reserved" "faulty"

usage state of cable

Responses

Request samples

Content type
application/json
{
  • "state": "used"
}

Response samples

Content type
application/json
{ }

Update usage state specific fiber strand in a given ribbon inside a fiber optic cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

ribbon
required
integer [ 1 .. 36 ]

fiber optic cable ribbon number

strand
required
integer [ 1 .. 48 ]

fiber optic cable strand number

Request Body schema: application/json
required
state
string (cableState)
Enum: "free" "used" "reserved" "faulty"

usage state of cable

Responses

Request samples

Content type
application/json
{
  • "state": "used"
}

Response samples

Content type
application/json
{ }

Update usage state specific channel inside a coaxial cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

channel
required
integer [ 1 .. 512 ]

channel number within the frequency range

Request Body schema: application/json
required
state
string (cableState)
Enum: "free" "used" "reserved" "faulty"

usage state of cable

Responses

Request samples

Content type
application/json
{
  • "state": "used"
}

Response samples

Content type
application/json
{ }

timeline points for specified cable

Authorizations:
openId
path Parameters
cableId
required
string <uuid>

internal cable identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Currencies

List of all defined currencies

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Get default monetary currency

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "currencyId": "578a82ad-a7ce-4f9c-ba5f-fbe27c1886f5",
  • "name": "Euro",
  • "symbol": "€",
  • "isoCode": "EUR"
}

update currency conversion rate

Authorizations:
openId
path Parameters
currencyId
required
string <uuid>

internal currency identifier

Request Body schema: application/json
rate
required
number <currency> >= 0

Responses

Request samples

Content type
application/json
{
  • "rate": 0.85
}

Response samples

Content type
application/json
{ }

Change default currency

Authorizations:
openId
path Parameters
currencyId
required
string <uuid>

internal currency identifier

Responses

Response samples

Content type
application/json
{ }

Ducts

Export ducts in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import ducts in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
ductId
string <uuid> (ductId)

optionally specify the internal duct identifier

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
trenchId
required
string <uuid> (trenchId)

internal trench identifier

purpose
required
string (ductPurpose)
Enum: "gas" "power" "cable" "water"

intended contents of the duct, note: cable means telecommunications cables including coax,copper for twisted-pair copper cable,ethernet,fiber etc.

category
required
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
required
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

state
required
string (ductState)
Enum: "free" "used" "reserved" "faulty"

state of duct

within
string <uuid> (ductId)

for a microduct or subduct which duct or microduct is it contained within

required
object (ductPlacement)

horizontal and vertical placement of the duct within the trench

source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "4f61c862-cbd6-4455-9cf2-3d478406c693"
]

Simple statistics for ducts

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

Add single duct

Authorizations:
openId
Request Body schema: application/json
required
trenchId
required
string <uuid> (trenchId)

internal trench identifier

purpose
required
string (ductPurpose)
Enum: "gas" "power" "cable" "water"

intended contents of the duct, note: cable means telecommunications cables including coax,copper for twisted-pair copper cable,ethernet,fiber etc.

country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
reference
string
cost
number <currency>
category
required
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
required
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

state
required
string (ductState)
Enum: "free" "used" "reserved" "faulty"

state of duct

within
string <uuid> (ductId)

for a microduct or subduct which duct or microduct is it contained within

required
object (ductPlacement)

horizontal and vertical placement of the duct within the trench

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
  • "country": "BEL",
  • "purpose": "cable",
  • "category": "microduct",
  • "configuration": 24,
  • "state": "free",
  • "placement": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693"
}

List of all known ducts

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "4f61c862-cbd6-4455-9cf2-3d478406c693",
  • "1ed39d9c-b95b-4745-a93c-f2fd49ef740d",
  • "74d91189-0b4f-4734-9666-b3b030502e80",
  • "253c57de-00ef-4819-b509-b99e82990125",
  • "eadfd1fb-2356-4666-9fd1-288bb393fa2a",
  • "b78af928-5e4f-43f3-bc61-fcef3af0740f",
  • "d9d00870-f242-4597-8168-152e0945709a",
  • "224c9a62-f49e-4ff8-a4cb-b20dab18345a",
  • "cec8b457-59ce-4b13-9627-b2d0a15248c5",
  • "f9f67501-9674-47a2-a0dc-d40f9c6554aa"
]

State capacity for ducts

Authorizations:
openId
query Parameters
from
string = 8 characters ^\d{8}$

range start date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
to
string = 8 characters ^\d{8}$

range end date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
before
string = 8 characters ^\d{8}$

before date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
after
string = 8 characters ^\d{8}$

after date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
aggregate
required
string
Enum: "day" "week" "month" "quarter" "half-year" "year"

unit of measure of the aggregation factor

Responses

Response samples

Content type
application/json
{
  • "by": "quarter",
  • "duct": [
    ]
}

delete single duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Replace entire single duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

Request Body schema: application/json
required
trenchId
required
string <uuid> (trenchId)

internal trench identifier

country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
reference
string
cost
number <currency>
purpose
required
string (ductPurpose)
Enum: "gas" "power" "cable" "water"

intended contents of the duct, note: cable means telecommunications cables including coax,copper for twisted-pair copper cable,ethernet,fiber etc.

category
required
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
required
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

state
required
string (ductState)
Enum: "free" "used" "reserved" "faulty"

state of duct

within
string <uuid> (ductId)

for a microduct or subduct which duct or microduct is it contained within

required
object (ductPlacement)

horizontal and vertical placement of the duct within the trench

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
  • "country": "BEL",
  • "purpose": "cable",
  • "category": "microduct",
  • "configuration": 12,
  • "state": "free",
  • "placement": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Update aspects of a single duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

Request Body schema: application/json
required
trenchId
string <uuid> (trenchId)

internal trench identifier

country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
reference
string
cost
number <currency>
purpose
string (ductPurpose)
Enum: "gas" "power" "cable" "water"

intended contents of the duct, note: cable means telecommunications cables including coax,copper for twisted-pair copper cable,ethernet,fiber etc.

category
string (ductSizeCategory)
Enum: "duct" "subduct"

size classification of the duct

configuration
integer (ductConfiguration) [ 1 .. 48 ]

1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle

state
string (ductState)
Enum: "free" "used" "reserved" "faulty"

state of duct

within
string <uuid> (ductId)

for a microduct or subduct which duct or microduct is it contained within

object (ductPlacement)

horizontal and vertical placement of the duct within the trench

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "state": "used"
}

Response samples

Content type
application/json
{ }

Get specified duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
  • "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
  • "country": "BEL",
  • "purpose": "cable",
  • "category": "microduct",
  • "configuration": 24,
  • "state": "used",
  • "placement": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Get list of cables within specified duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

Responses

Response samples

Content type
application/json
[
  • "5520aca1-4727-431a-aa9c-23f2e54b8a41"
]

Get list of subducts within specified duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

Responses

Response samples

Content type
application/json
[
  • "5520aca1-4727-431a-aa9c-23f2e54b8a41"
]

timeline points for specified duct

Authorizations:
openId
path Parameters
ductId
required
string <uuid>

internal duct identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Services

Export services in bulk

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import services in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
serviceId
string <uuid> (serviceId)

optionally specify the internal service identifier

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
required
object
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
object

Link Aggregation Group for bundling multiple connection points

required
object
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c"
]

timeline points for specified service

Authorizations:
openId
path Parameters
serviceId
required
string <uuid>

internal service identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Simple statistics for services

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

List of all known services

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "dab18895-c0ab-4267-815c-1d04b1b66586",
  • "be0b48c3-b149-42c7-abdc-65ac8a635f79",
  • "97fc88b7-f292-410d-8e5e-99644da22eb6",
  • "21f9393b-f07c-4007-bc40-ddf583c44204",
  • "6af1aa26-0e73-45a3-8593-d9dda68d9e21",
  • "7b253875-48c5-4cf7-b46a-495f67d2c58d",
  • "a0f8a856-38ae-430c-a648-7a46534e1ac6",
  • "e80a4d88-d56b-4d35-b25d-ab68e17d09c6",
  • "88a1237b-3a03-4037-ad5f-cc4c705b8e53",
  • "e6e6a1c9-b233-477b-9e2d-58b99ca26fbe"
]

Add single Service

Authorizations:
openId
Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
required
string
required
object
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
rate
integer [ 1 .. 768 ]
Default: 0

maximum service rate

unit
string
Default: "Gbps"
Enum: "Mbps" "Gbps" "Tbps"

unit of service rate

object

Link Aggregation Group for bundling multiple connection points

required
object
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "reference": "ZX2034-10-10",
  • "country": "BEL",
  • "customer": {
    },
  • "commissioned": "20241010",
  • "rate": 1,
  • "unit": "Gbps",
  • "lag": {
    },
  • "link": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "serviceId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c"
}

Update single service

Authorizations:
openId
path Parameters
serviceId
required
string <uuid>

internal service identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
object
commissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
rate
integer [ 0 .. 768 ]

maximum service rate

unit
string
Enum: "Mbps" "Gbps" "Tbps"

unit of service rate

object

Link Aggregation Group for bundling multiple connection points

object
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "link": {
    }
}

Response samples

Content type
application/json
{ }

Replace single service

Authorizations:
openId
path Parameters
serviceId
required
string <uuid>

internal service identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
required
object
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
rate
integer [ 0 .. 768 ]
Default: 0

maximum service rate

unit
string
Default: "Gbps"
Enum: "Mbps" "Gbps" "Tbps"

unit of service rate

object

Link Aggregation Group for bundling multiple connection points

required
object
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "reference": "ZX2034-10-10",
  • "country": "BEL",
  • "customer": {
    },
  • "commissioned": "20241010",
  • "rate": 1,
  • "unit": "Gbps",
  • "lag": {
    },
  • "link": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Delete specified Service

Authorizations:
openId
path Parameters
serviceId
required
string <uuid>

internal service identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Get specified service

Authorizations:
openId
path Parameters
serviceId
required
string <uuid>

internal service identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "serviceId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
  • "reference": "ZX2034-10-10",
  • "country": "BEL",
  • "customer": {
    },
  • "commissioned": "20241010",
  • "rate": 1,
  • "unit": "Gbps",
  • "lag": {
    },
  • "link": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Sites

Export sites in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import sites in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
siteId
string <uuid> (siteId)

optionally specify the site internal identifier

point
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
reference
required
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
area
string (areaType)
Default: "unclassified"
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
string (siteType)
Default: "unclassified"
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known
cost
number <currency>
required
object
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c"
]

Simple statistics for sites

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

Using an ellipsoidal model of the earths surface returns the distance between two sites

Authorizations:
openId
Request Body schema: application/json
required
from
required
string <uuid> (siteId)

internal site identifier

to
required
string <uuid> (siteId)

internal site identifier

Responses

Request samples

Content type
application/json
{
  • "from": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "to": "0de00152-657a-43c8-92ba-245428a23d74"
}

Response samples

Content type
application/json
{
  • "distance": 17.234567,
  • "unit": "m"
}

List of all known sites

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
  • "0de00152-657a-43c8-92ba-245428a23d74",
  • "582ad17e-d1cc-41f9-8277-09b2f7112d58",
  • "7060d226-d483-43c6-8432-4ed4de0fcd27",
  • "bdf1c15a-c91f-472f-bde6-2b3ff212b051",
  • "ffb9e869-a240-4a99-9f46-109802fb44e6",
  • "532dc221-d753-4799-815c-d7b9d36c59bc",
  • "43939c0a-fade-44d5-9eb3-4e50f9698d13",
  • "2e8c5466-4d0c-4193-91e0-605a45770833",
  • "e883b5ce-fca6-474d-873a-7b7cdaef097e"
]

Add single Site

Authorizations:
openId
Request Body schema: application/json
required
reference
required
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
onNet
boolean
Default: false
area
string (areaType)
Default: "unclassified"
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
string (siteType)
Default: "unclassified"
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known
cost
number <currency>
required
object
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "reference": "esp-zar-daro1",
  • "commissioned": "20241010",
  • "onNet": true,
  • "area": "commercial",
  • "type": "exchange",
  • "location": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}

List of all known off-network (offNet) sites

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of all known on-network (onNet) sites

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update aspects of single site

Authorizations:
openId
path Parameters
siteId
required
string <uuid>

internal site identifier

Request Body schema: application/json
required
reference
string
commissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
onNet
boolean
Default: false
area
string (areaType)
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
string (siteType)
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known
cost
number <currency>
object
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "reference": "esp-zar-daro1",
  • "commissioned": "20241010",
  • "decommissioned": "20250931",
  • "onNet": true,
  • "area": "commercial",
  • "type": "exchange",
  • "location": {
    }
}

Response samples

Content type
application/json
{
  • "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}

Replace single site

Authorizations:
openId
path Parameters
siteId
required
string <uuid>

internal site identifier

Request Body schema: application/json
required
reference
required
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
onNet
boolean
Default: false
area
string (areaType)
Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
  • residential
  • rural
  • industrial
  • mixed - combination of residential/industrial/commercial.
  • psz - Public Safety Zone
  • urban
  • unclassified - not recorded or known
  • utility - public service building, i.e. hospital, school
type
string (siteType)
Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
  • adu - accessory dwelling units
  • colo - colocation
  • commercial - place of work, retail unit etc.
  • dc - data center
  • exchange - district/town exchange building etc.
  • mdu - multi-dwelling unit
  • pop - point of presence
  • sdu - single dwelling unit
  • street - various street furniture options
  • unclassified - not recorded or known
cost
number <currency>
required
object
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "reference": "esp-zar-daro1",
  • "commissioned": "20241010",
  • "onNet": true,
  • "area": "commercial",
  • "type": "exchange",
  • "location": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Delete specified Site

Authorizations:
openId
path Parameters
siteId
required
string <uuid>

internal site identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Get specified site

Authorizations:
openId
path Parameters
siteId
required
string <uuid>

internal site identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
  • "reference": "esp-zar-daro1",
  • "commissioned": "20241010",
  • "onNet": true,
  • "area": "commercial",
  • "type": "exchange",
  • "location": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

timeline points for specified site

Authorizations:
openId
path Parameters
siteId
required
string <uuid>

internal site identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Racks

Export racks in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import racks in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
rackId
string <uuid> (rackId)

optionally specify the internal rack identifier

point
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
required
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
required
string <uuid> (siteId)

internal site identifier

floor
integer

floor level, 0 is ground level

area
string

room or allocated area

row
integer >= 0
column
integer >= 0
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
object (dimensions)

Height x Width x Depth of the item with a specified unit of measure

slots
required
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "a84eed87-277f-46ac-9ee3-094c0d104f1f"
]

Simple statistics for racks

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

List of all known racks

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "a84eed87-277f-46ac-9ee3-094c0d104f1f",
  • "fc1409a5-ddde-48af-858c-bb3b1f06cb02",
  • "c86c169c-0cca-4b55-a71c-81f2d0dac49b",
  • "f7c45506-435d-449a-a334-b438f9a7bee7",
  • "ccdc9a6e-0728-4073-9c33-892e294315be",
  • "fb66a40c-d6a4-41eb-a93a-07e2835908e6",
  • "08678ce9-e188-4af7-bc39-a88af5b36b17",
  • "617a6fc7-b9a2-4792-8f23-9c0d0919f699",
  • "fa3f37c9-b663-47ca-8add-82f068cd3688",
  • "98662042-c745-4fd0-af32-ecda683c5ca0"
]

Add single Rack

Authorizations:
openId
Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
required
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
required
string <uuid> (siteId)

internal site identifier

floor
integer

floor level, 0 is ground level

area
string

room or allocated area

row
integer >= 0
column
integer >= 0
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
object (dimensions)

Height x Width x Depth of the item with a specified unit of measure

slots
required
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

Array of objects

slot usage is considered free unless indicated otherwise

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "country": "BEL",
  • "reference": "esp-zar-f0-01",
  • "commissioned": "20241010",
  • "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
  • "floor": 0,
  • "area": "commercial",
  • "row": 1,
  • "column": 1,
  • "coordinate": {
    },
  • "dimensions": {
    },
  • "slots": 42,
  • "slotUsage": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f"
}

Update aspects of single rack

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
commissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
string <uuid> (siteId)

internal site identifier

floor
integer

floor level, 0 is ground level

area
string

room or allocated area

row
integer >= 0
column
integer >= 0
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
object (dimensions)

Height x Width x Depth of the item with a specified unit of measure

slots
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

Array of objects

slot usage is considered free unless indicated otherwise

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "slotUsage": [
    ]
}

Response samples

Content type
application/json
{ }

Replace single rack

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
required
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
required
string <uuid> (siteId)

internal site identifier

floor
integer

floor level, 0 is ground level

area
string

room or allocated area

row
integer >= 0
column
integer >= 0
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
object (dimensions)

Height x Width x Depth of the item with a specified unit of measure

slots
integer (rackSlots) [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

Array of objects

slot usage is considered free unless indicated otherwise

point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "reference": "esp-zar-f0-01",
  • "country": "ESP",
  • "commissioned": "20241010",
  • "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
  • "floor": 0,
  • "area": "commercial",
  • "row": 1,
  • "column": 1,
  • "coordinate": {
    },
  • "dimensions": {
    },
  • "slots": 42,
  • "slotUsage": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

delete specified rack

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Get specified rack

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
  • "reference": "esp-zar-f0-01",
  • "country": "ESP",
  • "commissioned": "20241010",
  • "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
  • "floor": 0,
  • "area": "commercial",
  • "row": 1,
  • "column": 1,
  • "coordinate": {
    },
  • "dimensions": {
    },
  • "slots": 42,
  • "slotUsage": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

slot usage for specified rack

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

usage for specified rack slot

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

slot
required
integer [ 1 .. 58 ]

number of physical slots in the rack, 1=1U, 42=42U etc.

Responses

Response samples

Content type
application/json
{
  • "usage": "free"
}

timeline points for specified rack

Authorizations:
openId
path Parameters
rackId
required
string <uuid>

internal rack identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Network Equipment

Export network equipment in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import network equipment in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
neId
required
string <uuid> (neId)

optionally specify the internal network equipment identifier

point
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
host
required
string <hostname>
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
required
string <uuid>
rackId
required
string <uuid>
slotPosition
required
string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]...

comma separated rack slot number in the range 1..58

mgmtIP
required
string <ipv4 ipv6>
  • IPv4 Address - The quad notation of IPv4, also known as dotted quad or dotted decimal notation, is a way to write IP addresses as four groups of decimal numbers separated by periods. Example: 192.0.2.146
  • IPv6 Address - The quad notation of an IPv6 address is the representation of an IPv6 address as four hexadecimal digits, or hextets, in each of eight groups separated by colons. Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
vendor
required
string
model
required
string
image
required
string

software firmware/image name

version
required
string

software firmware/image version

config
string

CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format

required
Array of objects non-empty
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "86e420f1-137b-4e34-9ff7-18bd12743a10"
]

Simple statistics for network equipment

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

Unique list of all known network vendors with model,image,version

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

List of all known network equipment

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "86e420f1-137b-4e34-9ff7-18bd12743a10",
  • "b43b07d6-a015-47a1-8108-fc686816c3b4",
  • "2a59a345-7568-4cb1-9bb9-6a4ebf889d38",
  • "d131b1c9-9d8f-4813-8838-a8021b6d3e9f",
  • "d14d2b4b-abcd-4e8f-a71e-b9885ee48865",
  • "4282053e-16c2-40c2-a6a8-15a7350c4f28",
  • "59630b2-6d46-4d9e-9dc5-5b14803d1655",
  • "6f3b3201-3630-4ca0-8949-2d9a3ae55e5f",
  • "295f6c2b-c057-4bfa-881c-eb021a357790",
  • "e2b55a83-8e81-437f-a3e0-7842b35b498b",
  • "71e9cf2b-ec4b-4781-b31c-db0a26ba7da1",
  • "b4fd1360-fa21-4e1e-82ea-8adb116586ca",
  • "66fe0cfd-4483-43a7-8fa0-1835d5bc3727",
  • "ba03d195-e046-4b58-895f-95089a370d76",
  • "a63f9d02-7ca8-43ea-b8c0-51c58720d4fb"
]

Add single network equipment

Authorizations:
openId
Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
host
required
string <hostname>
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
required
string <uuid>
rackId
required
string <uuid>
slotPosition
required
string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]...

comma separated rack slot number in the range 1..58

mgmtIP
required
string <ipv4 ipv6>
  • IPv4 Address - The quad notation of IPv4, also known as dotted quad or dotted decimal notation, is a way to write IP addresses as four groups of decimal numbers separated by periods. Example: 192.0.2.146
  • IPv6 Address - The quad notation of an IPv6 address is the representation of an IPv6 address as four hexadecimal digits, or hextets, in each of eight groups separated by colons. Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
vendor
required
string
model
required
string
image
required
string

software firmware/image name

version
required
string

software firmware/image version

config
string

CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format

required
Array of objects non-empty
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "host": "esp-zar-daro-01",
  • "country": "ESP",
  • "commissioned": "20241010",
  • "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
  • "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
  • "slotPosition": "2,3",
  • "mgmtIP": "10.23.72.4",
  • "vendor": "Juniper",
  • "model": "MX240",
  • "image": "JUNOS Base OS Boot",
  • "version": "12.3R6.6",
  • "ports": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "neId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}

delete specified network equipment

Authorizations:
openId
path Parameters
neId
required
string <uuid>

internal network equipment identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Get specified network equipment

Authorizations:
openId
path Parameters
neId
required
string <uuid>

internal network equipment identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "neId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
  • "host": "esp-zar-daro-01",
  • "country": "ESP",
  • "commissioned": "20241010",
  • "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
  • "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
  • "slotPosition": "1",
  • "mgmtIP": "10.23.72.4",
  • "vendor": "Juniper",
  • "model": "MX240",
  • "image": "JUNOS Base OS Boot",
  • "version": "12.3R6.6",
  • "ports": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Replace entire network equipment

Authorizations:
openId
path Parameters
neId
required
string <uuid>

internal network equipment identifier

Request Body schema: application/json
required
host
required
string <hostname>
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
commissioned
required
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
required
string <uuid>
rackId
required
string <uuid>
slotPosition
required
string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]...

comma separated rack slot number in the range 1..58

mgmtIP
required
string <ipv4 ipv6>
  • IPv4 Address - The quad notation of IPv4, also known as dotted quad or dotted decimal notation, is a way to write IP addresses as four groups of decimal numbers separated by periods. Example: 192.0.2.146
  • IPv6 Address - The quad notation of an IPv6 address is the representation of an IPv6 address as four hexadecimal digits, or hextets, in each of eight groups separated by colons. Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
vendor
required
string
model
required
string
image
required
string

software firmware/image name

version
required
string

software firmware/image version

config
string

CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format

required
Array of objects non-empty
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "host": "esp-zar-daro-01",
  • "country": "ESP",
  • "commissioned": "20241010",
  • "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
  • "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
  • "slotPosition": "2,3",
  • "mgmtIP": "10.23.72.4",
  • "vendor": "Juniper",
  • "model": "MX240",
  • "image": "JUNOS Base OS Boot",
  • "version": "12.3R6.6",
  • "ports": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Update aspects of a single network equipment

Authorizations:
openId
path Parameters
neId
required
string <uuid>

internal network equipment identifier

Request Body schema: application/json
required
host
string <hostname>
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
cost
number <currency>
reference
string
commissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
decommissioned
string (date) = 8 characters ^\d{8}$

NI date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
siteId
string <uuid>
rackId
string <uuid>
slotPosition
string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]...

comma separated rack slot number in the range 1..58

mgmtIP
string <ipv4 ipv6>
  • IPv4 Address - The quad notation of IPv4, also known as dotted quad or dotted decimal notation, is a way to write IP addresses as four groups of decimal numbers separated by periods. Example: 192.0.2.146
  • IPv6 Address - The quad notation of an IPv6 address is the representation of an IPv6 address as four hexadecimal digits, or hextets, in each of eight groups separated by colons. Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
vendor
string
model
string
image
string

software firmware/image name

version
string

software firmware/image version

config
string

CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format

Array of objects non-empty
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "version": "12.3R6.8"
}

Response samples

Content type
application/json
{ }

timeline points for specified network equipment

Authorizations:
openId
path Parameters
neId
required
string <uuid>

internal network equipment identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Poles

Export poles in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import poles in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
poleId
string <uuid> (poleId)

optionally specify the internal pole identifier

point
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
required
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

required
object
required
object
required
object
state
string (poleState)
Default: "free"
Enum: "free" "used" "reserved" "faulty"

state of (telegraph) pole

object

optional site, trench or pole link connection

required
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "a9e616ed-1b61-453f-b8f3-95f0449043a8",
  • "1e78228c-a6dd-4eed-80c8-bab65c6bcb37",
  • "e5f15575-d857-440b-b7a1-8e1b3cb04499",
  • "ad1577d0-75aa-41b0-b7b4-c5616e6a216a",
  • "f3f27251-c695-4242-861e-582aa2839622",
  • "d18b2455-6eee-4cf9-b6e1-6024ab243be3",
  • "c43e5fd0-f7cb-4eda-bbcf-e891bc5fddb2",
  • "307dc651-eb97-4718-9533-516e34534bfd",
  • "b14a3f1f-2124-4590-8885-9f9df8722809",
  • "51c1854f-e808-4b5a-9f21-a8c715420a90"
]

Simple statistics for poles

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

State capacity for poles

Authorizations:
openId
query Parameters
from
string = 8 characters ^\d{8}$

range start date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
to
string = 8 characters ^\d{8}$

range end date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
before
string = 8 characters ^\d{8}$

before date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
after
string = 8 characters ^\d{8}$

after date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
aggregate
required
string
Enum: "day" "week" "month" "quarter" "half-year" "year"

unit of measure of the aggregation factor

Responses

Response samples

Content type
application/json
{
  • "by": "month",
  • "pole": [
    ]
}

Add single pole

Authorizations:
openId
Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
required
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

required
object
required
object
required
object
state
string (poleState)
Default: "free"
Enum: "free" "used" "reserved" "faulty"

state of (telegraph) pole

object

optional site, trench or pole link connection

required
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "country": "GBR",
  • "purpose": "backhaul",
  • "construction": {
    },
  • "demographics": {
    },
  • "build": {
    },
  • "state": "free",
  • "connectsTo": {
    },
  • "coordinate": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "poleId": "a9e616ed-1b61-453f-b8f3-95f0449043a8"
}

List of all known poles

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "a9e616ed-1b61-453f-b8f3-95f0449043a8",
  • "1e78228c-a6dd-4eed-80c8-bab65c6bcb37",
  • "e5f15575-d857-440b-b7a1-8e1b3cb04499",
  • "ad1577d0-75aa-41b0-b7b4-c5616e6a216a",
  • "f3f27251-c695-4242-861e-582aa2839622",
  • "d18b2455-6eee-4cf9-b6e1-6024ab243be3",
  • "c43e5fd0-f7cb-4eda-bbcf-e891bc5fddb2",
  • "307dc651-eb97-4718-9533-516e34534bfd",
  • "b14a3f1f-2124-4590-8885-9f9df8722809",
  • "51c1854f-e808-4b5a-9f21-a8c715420a90"
]

delete single pole

Authorizations:
openId
path Parameters
poleId
required
string <uuid>

internal (telegraph) pole identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Replace entire single pole

Authorizations:
openId
path Parameters
poleId
required
string <uuid>

internal (telegraph) pole identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

required
object
required
object
required
object
state
string (poleState)
Default: "free"
Enum: "free" "used" "reserved" "faulty"

state of (telegraph) pole

object

optional site, trench or pole link connection

required
object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "country": "GBR",
  • "purpose": "backhaul",
  • "construction": {
    },
  • "demographics": {
    },
  • "build": {
    },
  • "state": "free",
  • "connectsTo": {
    },
  • "coordinate": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Update aspects of a single pole

Authorizations:
openId
path Parameters
poleId
required
string <uuid>

internal (telegraph) pole identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
string (polePurpose)
Enum: "service/drop" "link" "backhaul" "unclassified"

intended purpose of the contents carried between (telegraph) poles

object
object
object
state
string (poleState)
Enum: "free" "used" "reserved" "faulty"

state of (telegraph) pole

object

optional site, trench or pole link connection

object (coordinate)

A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:

  • X is the longitude with a range of -180 to +180 with scale 3 and precision 6
  • Y is latitude with a range of -90 to +90 with scale 2 and precision 6
  • Z scale 8 and precision 2
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "coordinate": {
    }
}

Response samples

Content type
application/json
{ }

Get specified pole

Authorizations:
openId
path Parameters
poleId
required
string <uuid>

internal (telegraph) pole identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "poleId": "a9e616ed-1b61-453f-b8f3-95f0449043a8",
  • "country": "GBR",
  • "purpose": "backhaul",
  • "construction": {
    },
  • "demographics": {
    },
  • "build": {
    },
  • "state": "free",
  • "connectsTo": {
    },
  • "coordinate": {
    },
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Get list of cables on specified pole

Authorizations:
openId
path Parameters
poleId
required
string <uuid>

internal (telegraph) pole identifier

Responses

Response samples

Content type
application/json
[
  • "5520aca1-4727-431a-aa9c-23f2e54b8a41"
]

timeline points for specified pole

Authorizations:
openId
path Parameters
poleId
required
string <uuid>

internal (telegraph) pole identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Trenches

Export trenches in bulk

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import trenches in bulk

Authorizations:
openId
Request Body schema: application/json
required
Array (non-empty)
trenchId
string <uuid> (trenchId)

optionally specify the internal trench identifier

point
required
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
required
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

reference
required
string
required
object
required
object
required
object
state
string (trenchState)
Default: "free"
Enum: "free" "used" "reserved" "faulty"

state of trench

object

optional site, trench or pole link connection

required
Array of objects (coordinate) non-empty
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Simple statistics for trenches

Authorizations:
openId
query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "total": 123,
  • "active": 91,
  • "inactive": 32
}

Add single trench

Authorizations:
openId
Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
required
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

reference
required
string
required
object
required
object
required
object
state
string (trenchState)
Default: "free"
Enum: "free" "used" "reserved" "faulty"

state of trench

object

optional site, trench or pole link connection

required
Array of objects (coordinate) non-empty
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "country": "GBR",
  • "purpose": "service/drop",
  • "reference": "gbr-worc-cg-south",
  • "construction": {
    },
  • "demographics": {
    },
  • "build": {
    },
  • "state": "free",
  • "connectsTo": {
    },
  • "coordinates": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{
  • "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d"
}

List of all known trenches

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

country
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAF Saint Martin (French part)
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe

Responses

Response samples

Content type
application/json
[
  • "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
  • "30f8afcd-f95d-4686-a7cf-7543911e3916",
  • "b091c215-68a4-4d53-bed0-fb70bf808ea3",
  • "6722383f-2dff-439a-8831-59fb491f143d",
  • "e276c320-df70-420d-841e-8cf9c7f0d731",
  • "1256dc14-6935-4848-9872-2d97abd777bf",
  • "791b0ccb-308b-44b9-ba9c-2f92b26015ac",
  • "68558a89-5b37-4c90-910d-876e1fffc19f",
  • "96f4b334-1647-48e6-99ec-4135247c3210",
  • "9bcd04c1-a307-4518-81ae-8c51a2e6bb5a"
]

delete single trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

query Parameters
predicted
null

Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only

restore
null

Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged

Responses

Response samples

Content type
application/json
{ }

Replace entire single trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

reference
required
string
required
object
required
object
required
object
state
string (trenchState)
Default: "free"
Enum: "free" "used" "reserved" "faulty"

state of trench

object

optional site, trench or pole link connection

required
Array of objects (coordinate) non-empty
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "country": "GBR",
  • "purpose": "service/drop",
  • "reference": "gbr-worc-cg-south",
  • "construction": {
    },
  • "demographics": {
    },
  • "build": {
    },
  • "state": "free",
  • "connectsTo": {
    },
  • "coordinates": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Response samples

Content type
application/json
{ }

Update aspects of a single trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

Request Body schema: application/json
required
country
any (countryCode)
Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE"

ISO 3166-1 alpha-3 three-letter country codes

  • ABW Aruba
  • AFG Afghanistan
  • AGO Angola
  • AIA Anguilla
  • ALB Albania
  • AND Andorra
  • ARE United Arab Emirates
  • ARG Argentina
  • ARM Armenia
  • ASM American Samoa
  • ATA Antarctica
  • ATG Antigua and Barbuda
  • AUS Australia
  • AUT Austria
  • AZE Azerbaijan
  • BDI Burundi
  • BEL Belgium
  • BEN Benin
  • BES Bonaire, Sint Eustatius and Saba
  • BFA Burkina Faso
  • BGD Bangladesh
  • BGR Bulgaria
  • BHR Bahrain
  • BHS Bahamas
  • BIH Bosnia and Herzegovina
  • BLM Saint Barthélemy
  • BLR Belarus
  • BLZ Belize
  • BMU Bermuda
  • BOL Bolivia, Plurinational State of
  • BRA Brazil
  • BRB Barbados
  • BRN Brunei Darussalam
  • BTN Bhutan
  • BWA Botswana
  • CAF Central African Republic
  • CAN Canada
  • CCK Cocos (Keeling) Islands
  • CHE Switzerland
  • CHL Chile
  • CHN China
  • CIV Côte d'Ivoire
  • CMR Cameroon
  • COD Congo, Democratic Republic of the
  • COG Congo
  • COK Cook Islands
  • COL Colombia
  • COM Comoros
  • CPV Cabo Verde
  • CRI Costa Rica
  • CUB Cuba
  • CUW Curaçao
  • CXR Christmas Island
  • CYM Cayman Islands
  • CYP Cyprus
  • CZE Czechia
  • DEU Germany
  • DJI Djibouti
  • DMA Dominica
  • DNK Denmark
  • DOM Dominican Republic
  • DZA Algeria
  • ECU Ecuador
  • EGY Egypt
  • ERI Eritrea
  • ESH Western Sahara
  • ESP Spain
  • EST Estonia
  • ETH Ethiopia
  • FIN Finland
  • FJI Fiji
  • FLK Falkland Islands (Malvinas)
  • FRA France
  • FRO Faroe Islands
  • FSM Micronesia, Federated States of
  • GAB Gabon
  • GBR United Kingdom of Great Britain and Northern Ireland
  • GEO Georgia
  • GGY Guernsey
  • GHA Ghana
  • GIB Gibraltar
  • GIN Guinea
  • GLP Guadeloupe
  • GMB Gambia
  • GNB Guinea-Bissau
  • GNQ Equatorial Guinea
  • GRC Greece
  • GRD Grenada
  • GRL Greenland
  • GTM Guatemala
  • GUF French Guiana
  • GUM Guam
  • GUY Guyana
  • HND Honduras
  • HRV Croatia
  • HTI Haiti
  • HUN Hungary
  • IDN Indonesia
  • IMN Isle of Man
  • IND India
  • IRL Ireland
  • IRN Iran, Islamic Republic of
  • IRQ Iraq
  • ISL Iceland
  • ISR Israel
  • ITA Italy
  • JAM Jamaica
  • JOR Jordan
  • JPN Japan
  • KAZ Kazakhstan
  • KEN Kenya
  • KGZ Kyrgyzstan
  • KHM Cambodia
  • KIR Kiribati
  • KNA Saint Kitts and Nevis
  • KOR Korea, Republic of
  • KWT Kuwait
  • LAO Lao People's Democratic Republic
  • LBN Lebanon
  • LBR Liberia
  • LBY Libya
  • LCA Saint Lucia
  • LIE Liechtenstein
  • LKA Sri Lanka
  • LSO Lesotho
  • LTU Lithuania
  • LUX Luxembourg
  • LVA Latvia
  • MAR Morocco
  • MCO Monaco
  • MDA Moldova, Republic of
  • MDG Madagascar
  • MDV Maldives
  • MEX Mexico
  • MHL Marshall Islands
  • MKD North Macedonia
  • MLI Mali
  • MLT Malta
  • MMR Myanmar
  • MNE Montenegro
  • MNG Mongolia
  • MNP Northern Mariana Islands
  • MOZ Mozambique
  • MRT Mauritania
  • MSR Montserrat
  • MTQ Martinique
  • MUS Mauritius
  • MWI Malawi
  • MYS Malaysia
  • MYT Mayotte
  • NAM Namibia
  • NCL New Caledonia
  • NER Niger
  • NGA Nigeria
  • NIC Nicaragua
  • NIU Niue
  • NLD Netherlands, Kingdom of the
  • NOR Norway
  • NPL Nepal
  • NRU Nauru
  • NZL New Zealand
  • OMN Oman
  • PAK Pakistan
  • PAN Panama
  • PCN Pitcairn
  • PER Peru
  • PHL Philippines
  • PLW Palau
  • PNG Papua New Guinea
  • POL Poland
  • PRK Korea, Democratic People's Republic of
  • PRT Portugal
  • PRY Paraguay
  • PSE Palestine, State of
  • PYF French Polynesia
  • QAT Qatar
  • REU Réunion
  • ROU Romania
  • RUS Russian Federation
  • RWA Rwanda
  • SAU Saudi Arabia
  • SDN Sudan
  • SEN Senegal
  • SGP Singapore
  • SHN Saint Helena, Ascension and Tristan da Cunha
  • SLB Solomon Islands
  • SLE Sierra Leone
  • SLV El Salvador
  • SMR San Marino
  • SOM Somalia
  • SPM Saint Pierre and Miquelon
  • SRB Serbia
  • SSD South Sudan
  • STP Sao Tome and Principe
  • SUR Suriname
  • SVK Slovakia
  • SVN Slovenia
  • SWE Sweden
  • SWZ Eswatini
  • SYC Seychelles
  • SYR Syrian Arab Republic
  • TCA Turks and Caicos Islands
  • TCD Chad
  • TGO Togo
  • THA Thailand
  • TJK Tajikistan
  • TKL Tokelau
  • TKM Turkmenistan
  • TLS Timor-Leste
  • TON Tonga
  • TTO Trinidad and Tobago
  • TUN Tunisia
  • TUR Türkiye
  • TUV Tuvalu
  • TWN Taiwan, Province of China
  • TZA Tanzania, United Republic of
  • UGA Uganda
  • UKR Ukraine
  • URY Uruguay
  • USA United States of America
  • UZB Uzbekistan
  • VAT Holy See
  • VCT Saint Vincent and the Grenadines
  • VEN Venezuela, Bolivarian Republic of
  • VGB Virgin Islands (British)
  • VIR Virgin Islands (U.S.)
  • VNM Viet Nam
  • VUT Vanuatu
  • WLF Wallis and Futuna
  • WSM Samoa
  • YEM Yemen
  • ZAF South Africa
  • ZMB Zambia
  • ZWE Zimbabwe
purpose
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

reference
string
object
object
object
state
string (trenchState)
Enum: "free" "used" "reserved" "faulty"

state of trench

object

optional site, trench or pole link connection

Array of objects (coordinate) non-empty
point
string (dateTime) = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00
source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
delete
boolean (delete)

NI internal metadata field to indicate record is marked for deletion

Responses

Request samples

Content type
application/json
{
  • "coordinates": [
    ]
}

Response samples

Content type
application/json
{ }

Get specified trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "trenchId": "5ef82c6f-b06b-4d93-a4c2-3b78b62dd7cf",
  • "reference": "gbr-worc-cg-south",
  • "country": "GBR",
  • "purpose": "service/drop",
  • "construction": {
    },
  • "demographics": {
    },
  • "build": {
    },
  • "state": "free",
  • "connectsTo": {
    },
  • "coordinates": [
    ],
  • "source": "historical",
  • "probability": 1,
  • "delete": false
}

Using an ellipsoidal model of the earths surface returns the specified trench length based on known geometries

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "distance": 0.014618,
  • "unit": "m"
}

State capacity for trenches

Authorizations:
openId
query Parameters
from
string = 8 characters ^\d{8}$

range start date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
to
string = 8 characters ^\d{8}$

range end date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
before
string = 8 characters ^\d{8}$

before date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
after
string = 8 characters ^\d{8}$

after date format in compressed ISO-8601. (YYYYMMDD)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • example:
    • 20241118 18-NOV-2024
aggregate
required
string
Enum: "day" "week" "month" "quarter" "half-year" "year"

unit of measure of the aggregation factor

Responses

Response samples

Content type
application/json
{
  • "by": "month",
  • "trench": [
    ]
}

timeline points for specified trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

geometry points for specified trench over entire lifetime, with each point containing the incremental detla change. *note*: property name `YYYYMMDDThhmmss` is dynamic and matches one of the entries in the `sets` array for `point`

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

Responses

Response samples

Content type
application/json
{
  • "20250228T000000": [
    ],
  • "20250302T000000": [
    ],
  • "20250402T000000": [
    ],
  • "sets": [
    ]
}

geometry points for specified trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

number of premises passed for specified trench

Authorizations:
openId
path Parameters
trenchId
required
string <uuid>

internal trench identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{
  • "passed": 20
}

Q2C

simple trench distance estimate

Authorizations:
openId
Request Body schema: application/json
required
purpose
required
string (trenchPurpose)
Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified"

intended purpose of the contents of the trench

type
string (constructionType)
Enum: "micro" "narrow" "backhoe" "inline" "portable" "large"

type of trench construction

trenchId
string <uuid> (trenchId)

internal trench identifier

isoCode
string (currencyIsoCode)
Default: "EUR"
Enum: "AUD" "BND" "CHF" "CLP" "DKK" "EUR" "FKP" "GBP" "INR" "NOK" "NZD" "RUB" "SGD" "SHP" "TRY" "USD" "XAF" "XCD" "XCG" "XOF" "XPF" "ZAR"

ISO code for currency

required
Array of objects (coordinate) >= 2 items

Responses

Request samples

Content type
application/json
{
  • "purpose": "service/drop",
  • "trenchId": "b55fcbef-6d4f-4803-8755-0d920835de85",
  • "isoCode": "EUR",
  • "coordinates": [
    ]
}

Response samples

Content type
application/json
{
  • "cost": 3.75,
  • "distance": 3.75,
  • "unit": "m",
  • "symbol": "€",
  • "isoCode": "EUR",
  • "rate": 1
}

Administration - Data

Export data settings

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "historical": {
    },
  • "predicted": {
    }
}

Import data settings

Authorizations:
openId
Request Body schema: application/json
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "historical": {
    },
  • "predicted": {
    }
}

Response samples

Content type
application/json
{ }

Get maximum retention duration of active system historical data

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "duration": 1,
  • "unit": "year"
}

Update maximum retention duration of active system historical data

Authorizations:
openId
Request Body schema: application/json
required
duration
required
integer >= 1
unit
required
string (durationUnit)
Enum: "second" "minute" "hour" "day" "week" "month" "quarter" "year"

unit of measure of the duration

Responses

Request samples

Content type
application/json
{
  • "duration": 6,
  • "unit": "month"
}

Response samples

Content type
application/json
{ }

Get maximum predicted duration of active system predicted data

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "duration": 6,
  • "unit": "month"
}

Update maximum predicted duration of active system predicted data

Authorizations:
openId
Request Body schema: application/json
required
period
required
integer >= 1
unit
required
string (durationUnit)
Enum: "second" "minute" "hour" "day" "week" "month" "quarter" "year"

unit of measure of the duration

Responses

Request samples

Content type
application/json
{
  • "period": 3,
  • "unit": "week"
}

Response samples

Content type
application/json
{ }

Administration - Email

Export email configurations

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import email configurations

Authorizations:
openId
Request Body schema: application/json
required
Array
emailProviderId
required
string <uuid> (emailProviderId)

optionally specify the internal email provider identifier

vendor
required
string

vendor name

address
required
string <uri>

email address

name
required
any <string>

email address name

required
object (emailSend)

outbound host, credentials and protocol used to send email

object (emailReceive)

inbound host, credentials and protocol used to receive email

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

List of all available Email providers

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "6eafc385-43a1-4b49-9dd9-902a2a12a4ad"
]

Register one Email provider

Authorizations:
openId
Request Body schema: application/json
required
vendor
required
string

vendor name

address
required
string <email>

email address

name
any <string>

email address name

required
object (emailSend)

outbound host, credentials and protocol used to send email

object (emailReceive)

inbound host, credentials and protocol used to receive email

Responses

Request samples

Content type
application/json
{
  • "vendor": "FastMail",
  • "address": "ni@cowdrey.net",
  • "name": "Network Insight",
  • "send": {
    },
  • "receive": {
    }
}

Response samples

Content type
application/json
{
  • "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad"
}

Unregister one Email provider

Authorizations:
openId
path Parameters
emailProviderId
required
string <uuid>

internal email provider identifier

Responses

Response samples

Content type
application/json
{ }

Get specified Email provider details

Authorizations:
openId
path Parameters
emailProviderId
required
string <uuid>

internal email provider identifier

Responses

Response samples

Content type
application/json
{
  • "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
  • "vendor": "FastMail",
  • "address": "ni@cowdrey.net",
  • "name": "Network Insight",
  • "send": {
    }
}

Update single Email provider

Authorizations:
openId
path Parameters
emailProviderId
required
string <uuid>

internal email provider identifier

Request Body schema: application/json
required
vendor
string

vendor name

address
string <uri>

email address

name
any <string>

email address name

object (emailSend)

outbound host, credentials and protocol used to send email

object (emailReceive)

inbound host, credentials and protocol used to receive email

Responses

Request samples

Content type
application/json

update both IMAP4 and SMTP passwords

{
  • "send": {
    },
  • "receive": {
    }
}

Response samples

Content type
application/json
{ }

Replace single Email Provider

Authorizations:
openId
path Parameters
emailProviderId
required
string <uuid>

internal email provider identifier

Request Body schema: application/json
required
vendor
required
string

vendor name

address
required
string <uri>

email address

name
any <string>

email address name

required
object (emailSend)

outbound host, credentials and protocol used to send email

object (emailReceive)

inbound host, credentials and protocol used to receive email

Responses

Request samples

Content type
application/json
{
  • "vendor": "FastMail",
  • "address": "ni@cowdrey.net",
  • "name": "Network Insight",
  • "send": {
    }
}

Response samples

Content type
application/json
{ }

Administration - Kafka

Export Kafka configurations

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import Kafka configuration

Authorizations:
openId
Request Body schema: application/json
required
Array
kafkaProducerId
string <uuid> (kafkaProducerId)

optionally specify the internal Kafka broker identifier

name
required
string

name of Kafka broker for human purposes

clientId
required
string
Default: "NI"
required
object (kafkaProducer)

outbound host, credentials and protocol used to send stream

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "f3fd73b2-f08b-43f5-ad36-54299bf7dfab"
]

List of all available Kafka brokers

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "5b1ef698-1cf3-4f12-a671-d60ff283db41"
]

Register one Kafka broker

Authorizations:
openId
Request Body schema: application/json
required
name
required
string

name of Kafka broker for human purposes

clientId
required
string
Default: "NI"
required
object (kafkaProducer)

outbound host, credentials and protocol used to send stream

Responses

Request samples

Content type
application/json
{
  • "name": "west",
  • "clientId": "NI",
  • "producer": {
    }
}

Response samples

Content type
application/json
{
  • "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41"
}

Unregister one Kafka broker

Authorizations:
openId
path Parameters
kafkaProducerId
required
string <uuid>

internal Kafka broker identifier

Responses

Response samples

Content type
application/json
{ }

Get specified Kafka broker details

Authorizations:
openId
path Parameters
kafkaProducerId
required
string <uuid>

internal Kafka broker identifier

Responses

Response samples

Content type
application/json
{
  • "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41",
  • "name": "west",
  • "clientId": "NI",
  • "producer": {
    }
}

Update single Kafka broker

Authorizations:
openId
path Parameters
kafkaProducerId
required
string <uuid>

internal Kafka broker identifier

Request Body schema: application/json
required
name
string

name of Kafka broker for human purposes

clientId
string
Default: "NI"
object (kafkaProducer)

outbound host, credentials and protocol used to send stream

Responses

Request samples

Content type
application/json
{
  • "producer": {
    }
}

Response samples

Content type
application/json
{ }

Replace single Kafka broker

Authorizations:
openId
path Parameters
kafkaProducerId
required
string <uuid>

internal Kafka broker identifier

Request Body schema: application/json
required
name
required
string

name of Kafka broker for human purposes

clientId
required
string
Default: "NI"
required
object (kafkaProducer)

outbound host, credentials and protocol used to send stream

Responses

Request samples

Content type
application/json
{
  • "name": "west",
  • "clientId": "NI",
  • "producer": {
    }
}

Response samples

Content type
application/json
{ }

Administration - Maps

Export map configurations

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import map configurations

Authorizations:
openId
Request Body schema: application/json
required
One of
Array
mapProviderId
required
string <uuid> (mapProviderId)

optionally specify the internal map provider identifier

vendor
required
string (mapVendorPlatform)
Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI"

supported map vendor platforms

default
boolean
Default: false

system-wide default provider

renderUrl
required
string <url>

base URL for map rendering operations

required
object

Responses

Request samples

Content type
application/json
Example
[]

Response samples

Content type
application/json
[
  • "09d475ec-96e1-4e9c-848d-06b432df59e7"
]

List of all available Map Providers

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "9fbb4c17-07fb-4990-ad84-22b8078ae58f",
  • "089b8099-dd52-419a-8bc8-b7fd87605bfe",
  • "ef48e255-d604-48a4-970a-c3d92fa271e8",
  • "a4ace64f-4ddd-4355-a4ea-71ee8e7d7a58",
  • "09d475ec-96e1-4e9c-848d-06b432df59e7"
]

Register one Map Provider

Authorizations:
openId
Request Body schema: application/json
required
One of
vendor
required
string (mapVendorPlatform)
Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI"

supported map vendor platforms

default
boolean
Default: false

system-wide default provider

renderUrl
required
string <url>

base URL for map rendering operations

required
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "mapProviderId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7"
}

Get default Map Provider identifier

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "mapProviderId": "09d475ec-96e1-4e9c-848d-06b432df59e7"
}

Unregister one Map Provider

Authorizations:
openId
path Parameters
mapProviderId
required
string <uuid>

internal map provider identifier

Responses

Response samples

Content type
application/json
{ }

Get specified Map Provider details

Authorizations:
openId
path Parameters
mapProviderId
required
string <uuid>

internal map provider identifier

Responses

Response samples

Content type
application/json
{
  • "mapProviderId": "09d475ec-96e1-4e9c-848d-06b432df59e7",
  • "vendor": "OpenStreet Map",
  • "default": false,
  • "renderUrl": "https://www.openstreetmap.org/render",
  • "identityProvider": {
    }
}

Replace one Map Provider

Authorizations:
openId
path Parameters
mapProviderId
required
string <uuid>

internal map provider identifier

Request Body schema: application/json
required
One of
vendor
required
string (mapVendorPlatform)
Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI"

supported map vendor platforms

default
boolean
Default: false

system-wide default provider

renderUrl
required
string <url>

base URL for map rendering operations

required
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{ }

Update one Map Provider

Authorizations:
openId
path Parameters
mapProviderId
required
string <uuid>

internal map provider identifier

Request Body schema: application/json
required
One of
vendor
string (mapVendorPlatform)
Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI"

supported map vendor platforms

default
boolean
Default: false

system-wide default provider

renderUrl
string <url>

base URL for map rendering operations

object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "credentials": {
    }
}

Response samples

Content type
application/json
{ }

Administration - Workflow Engine

Export workflow configurations

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import workflow configurations

Authorizations:
openId
Request Body schema: application/json
required
Array
workflowEngineId
string <uuid> (workflowEngineId)

optionally specify the internal workflow engine identifier

source
string (source)
Enum: "historical" "planned" "predicted"

NI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms

  • historical - value was supplied
  • planned - value was supplied as possibility or to become
  • predicted - value was generated
probability
number <float> (probability) [ 0 .. 1 ]

Is a measure of the likelihood that an resource will occur as described. It's a value between 0 and 1, where 0 indicates impossibility and 1 indicates certainty. note: fixed to 2 decimal places

  • for historical records this is expected to be 1 i.e. 100%
  • for predicted records this is typically to be 0.25 i.e. 25%
  • for planned records this will vary based on the planned record itself
name
required
string

name of workflow engine for human purposes

required
object (workflowEngine)

workflow engine host, credentials etc.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • "f069bd6c-e663-4c0c-a273-17840c1e8263"
]

List of all available workflow engines

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "f069bd6c-e663-4c0c-a273-17840c1e8263"
]

Register one workflow engine

Authorizations:
openId
Request Body schema: application/json
required
name
required
string

name of workflow engine for human purposes

required
object (workflowEngine)

workflow engine host, credentials etc.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "workflowEngineId": "f069bd6c-e663-4c0c-a273-17840c1e8263"
}

Unregister one workflow engine

Authorizations:
openId
path Parameters
workflowEngineId
required
string <uuid>

unique identifier of the workflow engine

Responses

Response samples

Content type
application/json
{ }

Get specified workflow engine details

Authorizations:
openId
path Parameters
workflowEngineId
required
string <uuid>

unique identifier of the workflow engine

Responses

Response samples

Content type
application/json
{
  • "workflowEngineId": "f069bd6c-e663-4c0c-a273-17840c1e8263",
  • "name": "camunda8",
  • "engine": {}
}

Update single workflow engine

Authorizations:
openId
path Parameters
workflowEngineId
required
string <uuid>

unique identifier of the workflow engine

Request Body schema: application/json
required
name
string

name of workflow engine for human purposes

object (workflowEngine)

workflow engine host, credentials etc.

Responses

Request samples

Content type
application/json
{
  • "engine": {
    }
}

Response samples

Content type
application/json
{ }

Replace single workflow engine

Authorizations:
openId
path Parameters
workflowEngineId
required
string <uuid>

unique identifier of the workflow engine

Request Body schema: application/json
required
name
required
string

name of workflow engine for human purposes

required
object (workflowEngine)

workflow engine host, credentials etc.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{ }

Predictive

Returns list of every historical resource and correspoding points

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "cable": {
    },
  • "duct": {
    },
  • "ne": {
    },
  • "pole": {
    },
  • "rack": {
    },
  • "service": {
    },
  • "site": {
    },
  • "trench": {
    }
}

Returns list of every predicted resource and correspoding points

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "cable": {
    },
  • "duct": {
    },
  • "ne": {
    },
  • "pole": {
    },
  • "rack": {
    },
  • "service": {
    },
  • "site": {
    },
  • "trench": {
    }
}

Remove item from internal predicton queue

Authorizations:
openId
path Parameters
qId
required
integer >= 0

internal prediction queue identifier

Responses

Response samples

Content type
application/json
{ }

Returns next item awaiting processing from internal prediction queue

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "qId": 1,
  • "point": "20250603T181300",
  • "resource": "cable",
  • "id": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
  • "state": "update"
}

Search

search

Authorizations:
openId
query Parameters
regex
null

Flag parameter used to indicate the supplied search phrase should be treated as a Regular Expression (RegEx), note: the RE2 RegEx library is used please review https://github.com/google/re2/wiki/Syntax for further details. example: searching for currencies ISO code, in this case, containing EUR

  • query:EU[[:alpha:]] result:found
  • query:EU[[:^alpha:]] result:not found note: any ' characters will be automatically escaped to \'
Request Body schema: application/json
required
resource
required
string (searchResourceType)
Enum: "adminEmail" "adminKafka" "adminMap" "adminWorkflow" "alert" "cable" "currency" "cve" "document" "duct" "ne" "pole" "rack" "service" "site" "trench" "*"

internal NI resource type to search, note: * will perform the search across all supported resource types

query
required
string

case insensitive query phrase specified with search, note: wildcards can also be included:

  • _ pattern matches single character
  • % pattern matches any sequence of zero or more characters example: searching for resources containing abc
  • query:a% result:found
  • query:_b_ result:found
  • query:c result:not found
  • query:c% result:not found
  • query:%c result:found
  • query:abc result:found

Responses

Request samples

Content type
application/json
Example
{
  • "resource": "*",
  • "query": "sample"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "found": 2,
  • "resource": "*",
  • "query": "sample"
}

Secrets

Add an authorization credential to the encrypted secret store

Authorizations:
openId
Request Body schema: application/json
required
One of
scope
required
string (secretScope)

scope identifier of the authorization credential

realm
required
string (secretRealm)

realm identifier of the authorization credential

type
required
string (secretType)
Enum: "identity" "plain" "snmp" "ssh" "ssl" "token"

type of the authorization credential that is to be managed, note:

  • identity for OAuth2.0/OIDC style secrets
  • plain for simple username/password style secrets
  • snmp for v1, v2c and v3c SNMP style secrets
  • ssh for SSH key-based with optional certificate style secrets
  • token for RESTful style API authorization style secrets
required
object (secretIdentity)

OpenID/OAuth style credential

object (secretPlain)

Plain username/password style credential

secretSnmpV1V2c (object) or secretSnmpV3 (object)
object (secretSsh)

SSH style credential with optional host certificate authority (CA)

object (secretSsl)

SSL style credential

object (secretToken)

RESTful API style token credential

Responses

Request samples

Content type
application/json
Example
{
  • "scope": "example",
  • "realm": "edge01gw",
  • "type": "plain",
  • "plain": {
    }
}

Response samples

Content type
application/json
{ }

Return an authorization credential, *note*: `scope`,`realm`,`type` must be known in advance

Authorizations:
openId
path Parameters
scope
required
string

scope identifier of the authorization credential

realm
required
string

realm identifier of the authorization credential

type
required
string
Enum: "identity" "plain" "snmp" "ssh" "ssl" "token"

type of the authorization credential that is to be managed, note:

  • identity for OAuth2.0/OIDC style secrets
  • plain for simple username/password style secrets
  • snmp for v1, v2c and v3c SNMP style secrets
  • ssh for SSH key-based with optional certificate style secrets
  • token for RESTful style API authorization style secrets

Responses

Response samples

Content type
application/json
Example
{
  • "scope": "example",
  • "realm": "edge01gw",
  • "type": "plain",
  • "plain": {
    }
}

Remove an authorization credential from the encrypted secret store, *note*: `scope`,`realm`,`type` must be known in advance

Authorizations:
openId
path Parameters
scope
required
string

scope identifier of the authorization credential

realm
required
string

realm identifier of the authorization credential

type
required
string
Enum: "identity" "plain" "snmp" "ssh" "ssl" "token"

type of the authorization credential that is to be managed, note:

  • identity for OAuth2.0/OIDC style secrets
  • plain for simple username/password style secrets
  • snmp for v1, v2c and v3c SNMP style secrets
  • ssh for SSH key-based with optional certificate style secrets
  • token for RESTful style API authorization style secrets

Responses

Response samples

Content type
application/json
{ }

Documents

Add content to the document store, *note*: all documents are considered to be historical

Authorizations:
openId
Request Body schema: multipart/form-data
required
document
string

document filename that is being uploaded

form-content
string <binary>

Responses

Response samples

Content type
application/json
{
  • "documentId": "d94641c3-4507-4589-882e-3d31621b3a0e",
  • "hash": "c96970e2220bf6385edc6b56d9682e4a",
  • "size": 4286,
  • "mimeType": "image/vnd.microsoft.icon"
}

List of all known documents

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "5520aca1-4727-431a-aa9c-23f2e54b8a41",
  • "df4600ba-c46f-428a-855d-eb84caf9b59c"
]

Fetch specified content from the document store

Authorizations:
openId
path Parameters
documentId
required
string <uuid>

internal document identifier

query Parameters
point
string = 15 characters ^\d{8}T\d{6}$

NI date format in compressed ISO-8601. (YYYYMMDDThhmmss)

  • YYYY 4-digit year
  • MM 2-digit month (with leading zeros < 10)
  • DD 2-digit day (with leading zeros if < 10)
  • literal T time start indicator
  • hh 2-digit hours (with leading zero if < 10)
  • mm 2-diigt minutes (with leading zero if < 10)
  • ss 2-digit seconds (with leading zero if < 10)
  • example:
    • 20241118T150800 18-NOV-2024 15:08:00

Responses

Response samples

Content type
application/json
{ }

Update specified content within the document store

Authorizations:
openId
path Parameters
documentId
required
string <uuid>

internal document identifier

Request Body schema: multipart/form-data
required
document
string

document filename that is being uploaded

form-content
string <binary>

Responses

Response samples

Content type
application/json
{
  • "documentId": "d94641c3-4507-4589-882e-3d31621b3a0e",
  • "hash": "c96970e2220bf6385edc6b56d9682e4a",
  • "size": 5145,
  • "mimeType": "image/vnd.microsoft.icon"
}

Remove specified content from the document store

Authorizations:
openId
path Parameters
documentId
required
string <uuid>

internal document identifier

Responses

Response samples

Content type
application/json
{ }

timeline points for specified document

Authorizations:
openId
path Parameters
documentId
required
string <uuid>

internal document identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Fetch Jobs

List of all known correlations

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "747ded39-4273-423b-8550-d2009f2d6575",
  • "4810b82c-961f-4949-92f7-550ceaff594b",
  • "2bbe3d5b-6975-45f4-a6ed-f1b67f990240"
]

Add single correlation

Authorizations:
openId
Request Body schema: application/json
required
required
object
required
object
type
required
string (correlationType)
Enum: "cable" "duct" "ne" "other" "pole" "rack" "service" "site" "trench" "unknown"

intended related resource of correlation

fetchJobId
required
string <uuid> (fetchId)

internal fetch job identifier

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "destination": {
    },
  • "type": "trench",
  • "fetchJobId": "4810b82c-961f-4949-92f7-550ceaff594b"
}

Response samples

Content type
application/json
{
  • "correlationId": "2e50d7ff-7e3a-479b-b45e-3e20146967af"
}

delete specified correlation

Authorizations:
openId
path Parameters
correlationId
required
string <uuid>

internal fetch correlation identifier

Responses

Response samples

Content type
application/json
{ }

Get specified correlation

Authorizations:
openId
path Parameters
correlationId
required
string <uuid>

internal fetch correlation identifier

Responses

Response samples

Content type
application/json
{
  • "source": {
    },
  • "destination": {
    },
  • "type": "trench",
  • "fetchJobId": "4810b82c-961f-4949-92f7-550ceaff594b"
}

List of all known fetch jobs

Authorizations:
openId
query Parameters
pageSize
integer [ 8 .. 128 ]

pagination page size

pageNumber
integer >= 1

pagination page number

Responses

Response samples

Content type
application/json
[
  • "747ded39-4273-423b-8550-d2009f2d6575",
  • "4810b82c-961f-4949-92f7-550ceaff594b",
  • "2bbe3d5b-6975-45f4-a6ed-f1b67f990240"
]

Add single fetch job

Authorizations:
openId
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "fetchId": "2e50d7ff-7e3a-479b-b45e-3e20146967af"
}

All enabled fetch job details

Authorizations:
openId

Responses

Response samples

Content type
application/json
{ }

Update aspects of single fetch job

Authorizations:
openId
path Parameters
fetchId
required
string <uuid>

internal fetch job identifier

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Replace single fetch job

Authorizations:
openId
path Parameters
fetchId
required
string <uuid>

internal fetch job identifier

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

delete specified fetch job

Authorizations:
openId
path Parameters
fetchId
required
string <uuid>

internal fetch job identifier

Responses

Response samples

Content type
application/json
{ }

Get specified fetch job

Authorizations:
openId
path Parameters
fetchId
required
string <uuid>

internal fetch job identifier

Responses

Response samples

Content type
application/json
{ }

World

Find country by coordinate

Find the matching ISO 3166-1 alpha-3 three-letter country code that contains the supplied coordinate

Authorizations:
openId
Request Body schema: application/json
required
x
required
number <float> [ -180 .. 180 ]
Default: 0

measured along east-west axis

y
required
number <float> [ -90 .. 90 ]
Default: 0

measured along north-south axis

z
number <float>
Default: 0

measured height or elevation

m
string

extra axis of information not associated with the cartesian x/y/z space

Responses

Request samples

Content type
application/json
{
  • "x": -4.43205199969999,
  • "y": 57.4943539998374
}

Response samples

Content type
application/json
{
  • "country": "GBR"
}